Activity Properties Interface |
|
General Tab
Table 1. Fields on the General tab
Field |
Description |
---|---|
Description |
Indicates a meaningful description of the current activity. You may add a meaningful description for the current activity for future reference.While typing the description, auto suggest help appears based on existing description of labels and fields. The activity description is translated to a preferred language if user configures the language settings. The description for the activities and models can be seen in PIM activity table and graphical view in the preferred language selected in CUSP. |
Font Size |
Indicates the font size of text description for the current activity in the business process model. Increase or decrease the font size of the text within an activity for visibility or easy readability. The default font size is 12. |
Priority |
Priority indicates the importance of the User Interface activity or task on how it is executed. Select a priority when you have specific criteria to be met before an activity is executed. The execution priority of an activity can be Same as Process or Specific to Workflow. When you select the Specific to Workflow option, the Static Value and Normal values appear by default. Depending upon the importance of the User Interface activity, you need to select the appropriate priority, which can be Static Value or Read from Message. The following options are displayed in a drop-down list for a Static Value:
|
Message Type |
Message is a piece of meaningful information whose intent could result in a task being performed, or for sharing purpose. Select the message type as Info or Task. By default the message type is Task. If the message type is Task you can send the task to all linked users (applicable only when the Assignee Type selected is Role) to execute that task while the business process goes into a 'waiting' state till the user acts upon the task. If the assignee of User Interface is a Role or User, then the task is considered to be completed only after all the linked users act upon it. Linked users are a group of users who are expected to act upon parts of a single task. However, if the assignee of the User Interface is a single user, the task is considered to be completed once the user acts upon it. However, if you feel that the User Interface contains only information to be shared and does not need to be acted upon, then you need to specify the message type as Info.
|
Execute Condition |
Based upon the business requirement, you need to specify the condition for executing an activity. When you know the exact parameters to build the condition, you may specify a Static Value and, if the exact parameters to perform the condition are not known, it is recommended to specify Read from Message wherefrom the condition should be picked up from a message that holds the condition. The activity is executed only if the result of set the condition is true, otherwise the activity is skipped. When the execute condition is of type Read from Message, the XPath editor icon ( ) appears at the end of this field. You can build a condition by clicking this icon. If the execute condition is None, the execute condition does not apply at all and the activity is executed as a matter of fact. |
Execution User Type |
Execution User Type can be either a Process Instantiation User or a Current User. By default, the Execution User Type is set as Current User for any type of Activity which has this property.
|
Message to Send |
Click and from the Select a Message window, select required message . The Select a Messagewindow displays all process specific messages, Web service message and Independent Sub-process messages that are available for the current business process model. Note: You may also Add Document or Add Runtime Reference from the Select a Message window. |
Input Message |
|
Use current user context of Sub Process on callback |
When you want only the current user of the sub process to perform subsequent tasks of the main business process, select the Use current user context of Sub Process on callback checkbox. For example, consider that in a specific department, there are a set of tasks which need to be performed only after obtaining a Manager's approval. Also, consider that some of these tasks are part of sub processes. In such a scenario, once the Manager approves, all the tasks that are performed in this context need to have the Manager as the current user so that for future reference, it can be known as to who approved the tasks. |
Application Tab
Note: The Application tab appears only when there is a User Interface or Web Service activity or a Decision Table in the business process model. All the fields on the Application tab appear in read-only mode.
Table 2. Fields on the Application tab
Field |
Description |
---|---|
Name |
The name of the User Interface, Web Service or the Decision Table or the application that is used by the current activity. |
Description |
The description of the User Interface, Web Service, Decision Table or the application. |
Application URL |
This field displays the location of the User Interface. This field displays the location of the application having file extensions such as .htm, .jsp, .caf, and so on. For example, for an application having a .CAF file extension, where XForms1 is a User Interface, the application URL will be / cordys /Xform1 . caf when the process is published. |
UI Application Type |
This field displays the type of the UI application that is attached to the User Interface, Web Service or the Decision Table. For example, XForms. |
Workflow Model Tab
Note: The Workflow Model tab appears only when there is a User Interface in the business process model.
Table 3. Fields on the Workflow Model tab
Field |
Description |
---|---|
Delivery Model |
You need to specify the delivery format for the User Interface as to how it should appear when it reaches the Process Platform Inbox. If a user interface does not have any delivery model specified for it, then business process cannot be completed. Click to select an existing delivery model for the User Interface or External User Interface from the Select a Delivery Model window. Note: To select a delivery model, you must first create a delivery model. If a delivery model has Inbox Model and Email Model enabled, the Use Inbox Model and Use Email Model check boxes appear once you attach the delivery model to the task. When there is only Inbox or Email model enabled for the delivery model, only the corresponding checkbox, that is, only Use Inbox Model or Use Email Model checkbox appears. However, if a delivery model does not have Inbox model or Email model enabled, then neither of these corresponding check boxes appear. Select the appropriate checkbox that appears for the delivery model. You can configure Inbox and or Email models for Team and Worklist as well. A task may have both Inbox and Email models configured for it. |
Notification Subject |
Specify the notification subject so that the recipient of your task understands what the task contains or indicates. The value for this field is filled based on the description of the activity. But, if a pre-defined Inbox Model is selected, then the value is filled based on the subject of the selected Inbox Model. If you do not use the Inbox Model but use an email client as Inbox, then the task is sent to the role linked to the activity through email instead of the Process Platform Inbox, and the subject of the email is the Inbox Model name or the defined Notification Subject. The Notification Subject can be of types - Static Value or Read from Message. Select the Read from Message option if you want to dynamically set a notification subject at runtime. Select the Static Value option if you want to specify the subject for notification during design time. |
Dispatch Algorithm |
A Dispatch Algorithmis the document which allows you to define your custom dispatch logic to identify the receiver of the task at runtime.Using this document, you may define your implementation logic to decide on the target. The target could be a user, role, team or a worklist. Note: It is recommended to specify dispatch algorithm when there are multiple users to ensure that there is no confusion on who will perform the said task and this also helps to manage load balancing. |
Task Nature |
When multiple tasks need to be completed by users, it is recommended to specify the task nature to demarcate whether or not a user performing the first task should get the second task. Consider a scenario wherein, the first task is that of developing and the second task is testing. In such a case, the user who performs development should not be allowed to perform the testing task.Select 4Eye Nature or Rendezvous Nature property.
|
Initial Action |
Specify the initial action during the task delivery. The initial action can be either Create or Suspend. The Create option is the default option and the task is delivered in the assigned state. When the Suspend option is selected, the task is delivered in the suspended state. You can provide the initial action dynamically by using the Read from Message option, but the accepted values are only 'CREATE' or 'SUSPEND'. If the values other than 'CREATE' or 'SUSPEND' are provided by using the Read from Message option, the task delivery fails and the process aborts. |
Note: The Work Assignment tab appears only when there is a User Interface or human activity in the business process model.
Work Assignment Tab
Table 4. Fields on the Work Assignment tab
Field |
Description |
---|---|
Inherit from Swimlane |
This field appears only when the activity is a part of a swimlane. Selecting this option will enable the activity to inherit the settings of the swimlane. For example, if a role is attached to a swimlane, all the activities within the lane inherit the role from the swimlane. |
Assignee Type |
Based on your business requirements, you may have a single user, multiple users, or teams working upon an activity or a set of activities. Therefore, it is important to select an assignee type to clearly indicate who must perform the current task. Select the assignee type as one of the following: Worklist, Role, User, or Team. This indicates that the task can be assigned to a worklist, role, user, or a team respectively. If the exact parameters to specify the assignee is not known, it is recommended to specify Read from Message, which allows you to assign a type that can be one of the following:
|
All linked users must execute the task |
When a task is delivered, the business process remains in 'Waiting' state until all the linked users complete the task; the execution of the business process will continue only after the task is completed by all the linked users. Select this option to enable all linked users to execute the task. If you do not select this option, the business process execution continues after any one of the linked users execute the task. Note: This field appears only if the Assignee Type is Role or when Read from Message is specified for User. |
Assign To User |
This is an optional field, which appears if the message type is Task and when the Assignee Type of the task is Role, Team, or Worklist. This property is used to specify the user to whom the task must automatically be assigned after delivery. In run-time during the process instance execution, the XPath specified for this field must either have a valid user DN or can be left empty. Note:
|
E-Mail Tab
Note: The E-Mail tab appears when the Message Type of the User Interface is Info or Task.
Table 5. Fields on the E-Mail tab
Field |
Description |
---|---|
Read Recipients from Message |
Before setting the properties for the E-Mail tab ensure that you create the E-Mail Model. You need to select the recipients to whom you intend to send the info so that they are notified at the appropriate moment. Click associated with the To, Cc, and or Bcc fields. The XPath Editor window appears. Select the relevant elements that hold values of the recipients at runtime. |
Sender details |
Provide the exact Email address of the sender so that the recipients know who sent the message or task to their Process Platform Inbox. Provide the following details:
|
Abort activity on e-mail delivery failure |
Select this option to ensure that the activity is aborted if the e-mail is not delivered to the recipient(s). If you do not select this checkbox then the process continues with the next activity even when the delivery of e-mails fail. |
Duration Tab
Note: The Duration tab appears only when the Message Type of the User Interface is Task.
Table 6. Fields on the Duration tab
Field |
Description |
---|---|
Use Business Calendar for Start and Due Time calculation |
You may have the need to use a business calendar when you want to specify your organizations' working and non- working days to handle tasks more efficiently. This will ensure for exact calculation of the time spent on a task taking into account the non-working hours and days. To associate your business process model with a business calendar, select the Use Business Calendar checkbox. However, if you wish to continue with the default work-week i.e. 24* 7, you need not select this checkbox. Select a specific business calendar to link it to the activity. Click Working with a Business Calendar to get more information. Select this checkbox to attach a business calendar to the task. When you select this checkbox a drop-down field appears from which you may select any one of the following:
|
Start Time |
Defining a start time helps the user(s) to know by when they need to start upon a task so that they may finish it as per schedule. Defining the start time helps to organize work better and to address the activity on hand in time. The tasks will be delivered to Process Platform Inbox and will be available in the 'Calendared tasks' view. On expiry of the start time, the task will be displayed in the tasks list. If the start time is not defined, there is a possibility for performing an activity ahead of schedule or behind schedule which may affect priority work. Note: If you have not selected the Use Business Calendar checkbox, only Static Duration (time is specified at design time) and Read Duration from Message (the condition that holds the time in the message is selected as an XPath expression - time is specified at runtime) appear in the drop-down list. If you selected the Use Business Calendar, the following options appear. Select a start time from the drop-down list :
|
Due Time |
Specifying a due time helps the user(s) to know by when they should complete the assigned task. Even when the due time exceeds, the task remains active and is highlighted. Note: If you haven't selected the Use Business Calendar for Start and Due Time calculation checkbox, only Static Duration (time is specified at design time) and Read Duration from Message (the condition that holds the time in the message is selected as an XPath expression - time is specified at runtime) appear in the drop-down list. If you selected the Use Business Calendar for Start and Due Time calculation, the following options appear. Select a due time from the drop-down list :
|
Due Time > Set Reminder for Due Time |
It helps to set a reminder for the task so that the user(s) working upon it are reminded in time to complete the task before the set end time. When a reminder is set for the due time, the reminder appears in the user's Process Platform Inbox as per the defined time. Note: If you have not selected the Use Business Calendar checkbox, only Static Duration and Read Duration from Message appear in the drop-down list. If you selected the Use Business Calendar, the following options appear. Set reminders for due time which can be specified as:
|
Allow Due Time Change in Inbox |
This option enables modification of the Due Date of a task in Process Platform Inbox. When this check box is selected, the task recipient can modify the Due Date on the Modify System Attributes dialog box accessed through Process Platform Inbox. Leave this check box clear (default behavior), to prevent the task recipient from modifying the due date. Caution: If you modify the Due Date of a task, the escalations and reminders associated with it will also be updated. Therefore, select the check box only if you are sure of allowing the Due Date to be changed. |
Due Time > Reminder Subject |
An appropriate meaningful subject for the reminder helps the user(s) performing the task to understand how much time is left to complete the said task before the end time. This helps them to prioritize their activities/daily routine and focus upon completing the task. Enter a reminder subject so that it is flashed when the reminder pops up. |
Include start day (Day on which Task is Delivered) |
Select this checkbox if the start day needs to be included to calculate the due date of the task. From the Calculation Ends On drop-down list, select Start of Next Business Day if you want to include the start of next business day as the start day of the task or select End of Business Day if you want to include the end of current business day as the start day of the task. |
Escalation Tab
Note: The Escalation tab appears only when the Message Type of the User Interface is Task.
Table 7. Fields on the Escalation tab
Field |
Description |
---|---|
Escalate On |
Set escalations for a task activity when it crosses the due time. Based on escalations defined, either notifications or task re-assignment should be made. Note: This option will not be available for a workflow activity of type Info. |
Send Notification |
When a task is not completed within the prescribed time frame, appropriate users must be informed so that suitable action can be taken to ensure that the task is completed at the earliest possible time. To achieve this purpose, select this check box to send notification to any of the following entities:
|
Reassign Task |
When a task is not completed within the prescribed time frame and is escalated to relevant users to inform about the delay in completing it, you may want to reassign the task to same or different user(s) or teams or a user having a specific role. To achieve this purpose, select this check box to reassign workflow tasks to any of the following entities:
|
Monitoring Tab
Table 8. Fields on the Monitoring tab
Field |
Description |
---|---|
Configure Monitoring |
Monitoring at the activity level is done to keep track of activity level information at run time. If monitoring is disabled, the activity/task related information is not stored for future reference in PIM (Process Instance Manager). However, disabling monitoring improves the performance of process execution. For a long lived process, this option is selected by default. You may enable or disable monitoring for the task. |
Monitor Level |
By default, the options defined in the Default Activity Monitoring tab at the process level will be inherited by the newly created task. But these settings can be customized accordingly.
|
Recovery Tab
Note: The Recovery tab appears only when a Web service, Send Message, Receive Message, Decision Table, Case Model Activity, Independent Sub-process, Task is attached to an activity.
Table 9. Fields on the Recovery tab
Field |
Description |
---|---|
Store recovery data before the execution of this activity |
When you enable the store recovery point for the activity, only the data pertaining to 'before the execution of the current activity' is stored and the process execution resumes from that point. Also, to store activity level data you must enable it at business process model level. Select the checkbox to store recovery data before the current activity is executed. |
Store recovery data after the execution of this activity |
When you enable the store recovery point for the activity, only the data pertaining to 'after the execution of current activity' is stored and the process execution resumes from that point. Also, to store activity level data you must enable it at business process model level. Select the checkbox to store recovery data after the current activity is executed. By default, this checkbox remains selected. |
Webservice Tab
Note: The Webservice Options tab appears only when a Web service is attached to an activity.
Table 10. Fields on the Webservice Options tab
Field |
Description |
||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Timeout in seconds |
Specify the maximum time (in seconds) a Web service may take to complete. The business process sends request and waits for the response as per the time specified in this field.
Use this option to set longer time frames for SOAP requests that take longer to complete. For example, when several tables have to be updated in the database, you may need time-out periods of more than 30 seconds. Based upon the business requirement, you need to specify the parameters for executing the Web service activity. To perform the Web service activity:
At runtime, the timeout in seconds is read from the XPath provided in the Timeout in seconds field. The Web service activity is executed (iterated) for each XML node in the Message Map that matches the XPath condition. This ensures that the business process does not have to be modified for every change. |
||||||||||||||||||||||||||||
Perform other tasks simultaneously |
Select this option for Web service activities which take long time to respond. For example, calling an external Web service or updating multiple records in a database. If this check box is selected, the activities send the SOAP request asynchronously. In this case the process instance waits for the response and releases the resources which can then be used by other process instances. Also, response time-out caused in a synchronous call can be eliminated to prevent the activity to abort because of timeout. Note:
|
||||||||||||||||||||||||||||
Use reliable messaging |
Reliable messaging uses queue to ensure that Web service calls are not lost due to unavailability of the Process Engine. For example, if the Process Engine is not running or not yet started, the Web service calls stay in the queue till the Process Engine is started. As a result, the Web service calls may take longer time for execution as services are in a waiting state for some service provider to read the message from the queue and process it. The actual process waits for the response or does not depend on the Output message expected selection. When during processing if it encounters any exception scenario the message is roll backed to the queue again and the activity status is aborted. Note:
|
||||||||||||||||||||||||||||
Output message expected |
Indicates that an output of the SOAP service is expected. This option is selected by default. The behaviour pattern of this option along with other options is as follows:
Note: If the reliable messaging option is selected and process execution mode is short lived then this option is hidden. |
||||||||||||||||||||||||||||
Return standard error on SOAP fault |
If you want to be notified when a SOAP fault occurs in a specific structured message, select this option to map different types of SOAP faults returned by a Web service (activity) to the Process Engine's standard SOAP faults, that is, communication failures. These faults are treated as a single type of exception so that they can be handled in a common manner. If this option is cleared, any SOAP fault returned by the Web service is returned as it is. |
Behaviour pattern of various options
Legends
: Hidden (Not Applicable)
: Selected
: Not selected
Webservice Options | |||||
Message Exchange Pattern | Execution Behaviour | Applicable Process Mode | Perform other tasks simultaneously | Use reliable messaging | Output message expected |
---|---|---|---|---|---|
Request - Response | The business process sends a request and waits for the response message or goes into timeout. The receiver processes the request and replies with a response message or a fault. | Long Lived Short Lived |
|||
Request - Delayed Response | This pattern is similar to Request-Response pattern except timeout. After sending a request, business process indefinitely waits for the response message. During this period, the business process releases the resources which can then be used by other process instances. Request and Response messages are independent, and message correlation is used to map a response to the corresponding request. |
Long Lived |
|||
Fire-and-Forget | The business process sends a request and proceeds to the next activity without waiting for a response. | Long Lived Short Lived |
|||
Request- Delayed Response (Reliable) | This is similar to the Request - Delayed Response pattern but messaging queues are used for asynchronous and reliable delivery of the message. | Long Lived |
|||
Fire-and-Forget (Reliable) | This similar to the Fire-and-Forget pattern but messaging queues are used for asynchronous and reliable delivery of the message. | Long Lived Short Lived |
|
|
|
Retry Tab
Note: The Retry tab appears only for Web service activities. It allows for retrying the Web service activity in case of an error.
Table 11. Fields on the Retry tab
Field |
Description |
---|---|
Retry count |
Retry count indicates the number of retry attempts made for the Web service activity when it is aborted. The default value for Retry Countis zero. If you do not specify the retry count, an attempt to restart the Web service activity to execute it is not made. Note:
|
Define retry condition |
Select this check box to specify the Retry condition field. |
Retry condition |
When you specify the retry condition, the activity is retried only when the evaluation of the Boolean condition returns 'true'. This condition is evaluated before every attempt to retry the activity. The Retry condition is an optional parameter and can hold an XPath condition returning Boolean result. |
Retry interval in hours |
Specifying the retry interval in hours helps you to ready or streamline related activities so that when the next retry attempt happens the activity is successfully executed. Specify the time delay between the retry attempts which is entered in hours. |
Retry interval in minutes |
Specifying the retry interval in minutes helps you to ready or streamline related activities so that when the next retry attempt happens the activity is successfully executed. Specify the time delay between the retry attempts which is entered in minutes. |
Retry interval in seconds |
Specifying the retry interval in seconds helps you to ready or streamline related activities so that when the next retry attempt happens the activity is successfully executed. Specifies the time delay between the retry attempts which is entered in seconds. Note: The minimum value for the retry interval is 10 seconds. |
Note: The Debug tab is used to send an instantiated process directly to the debug ready state in the Process Instance Manager.
Table 12. Fields on the Debug tab
Field |
Description |
---|---|
Debug Process at Activity |
While executing a specific activity, you may want to debug the business process to view errors, if any, and correct them so that all the activities are executed as intended and the business process is successfully implemented. In such a situation, you may choose to debug or not to debug the business process when the current activity is executed. If you choose to debug the business process, then you need to specify whether you wish to perform the debug operation each time the current activity is executed, or based only on a specified condition. Specify these parameters based on your requirement or expectations of the business process. You have the following three options in the Debug Process at Activity drop-down list to choose:
|
Estimated Duration Tab
Note: The Estimated Duration tab appears only when the Message Type of the User Interface is Task.
Table 13. Fields on the Estimated Duration tab
Field |
Description |
---|---|
Estimated Lead Time |
The estimated lead time, or the time duration from assignment of a task to a certain user, till the time the task is completed by the user. You can define the elapsed time for each activity (that is a URL or Application) in the process. The Elapsed Time field has the following fields:
|
Estimated Spend Time |
The spend time is the time duration from when the task is started, from the Process Platform Inbox, till the time the task is completed by the user. You can defined the actual time spent for each activity (that is a URL or Application) in the process. The Elapsed Time field has the following fields:
|
Attachments tab
Note: The Attachments tab appears only when there is a User Interface in the business process model.
Table 14. Fields on the Attachments tab
Field |
Description |
---|---|
Assign an Attachment |
Click to create an attachment. Select an attachment definition from the drop- down list to assign it to an activity. |
Read |
Select the check box to allow the user to download and view the attachment. |
Write |
Select the check box to download the attachment and modify the contents, or add a new attachment to the task. |
Delete |
Select the check box to enable the user to view the attachment, modify the contents in the attachment, add another attachment, or delete the attachment too. |
Links Tab
Note: The Links tab appears only when there is a User Interface in the business process model.
Table 15. Fields on the Links tab
Field |
Description |
---|---|
URL |
When you have Website links which the user(s) should visit to perform the assigned task, specify the URL of the website attached to the task. |
Description |
A description of the website attached to the task. |
KPI Tab
Note:
The KPI tab appears at the Business process and Activity level.
Table 14. Fields on the KPI tab
Field |
Description |
---|---|
Create a KPI |
Click to add a KPI to the BPM. A KPI wizard is displayed. Refer to Creating a KPI on a Business Process Model topic for the detailed procedure. |
Edit |
To edit or view the KPI, double-click the KPI and make the relevant changes to it in the KPI editor that appears. |
Delete |
Select the check box for the KPI to be deleted and click . |
Annotation Tab
Table 16. Fields on the Annotation tab
Field |
Description |
---|---|
Annotation |
Additional notes or comments on the task, if any. |